Storage Sync Swagger preview version (prev PR #109 by ankushbindlish2 · Pull Request #3211 · Azure/azure-rest-api-specs

ankushbindlish2 · 2018-06-11T19:46:13Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

AutorestCI · 2018-06-11T19:47:08Z

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#252

AutorestCI · 2018-06-11T19:47:40Z

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2734

AutorestCI · 2018-06-11T19:48:01Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

AutorestCI · 2018-06-11T19:53:18Z

Automation for azure-sdk-for-node

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-node#2985

AutorestCI · 2018-06-11T20:28:21Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

annatisch · 2018-06-12T00:38:29Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+                "type": "string"
+              }
+            }
+


Is it possible to give this a more descriptive name? E.g. 'StorageSyncError'

annatisch · 2018-06-12T00:45:42Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+  "info": {
+    "title": "Microsoft Storage Sync",
+    "description": "Microsoft Storage Sync Service API",
+    "version": "2017-06-05-preview"


Could you add the client name here? Something like:

"x-ms-code-generation-settings": { "name": "StorageSyncClient" or "StorageSyncManagementClient" }

annatisch · 2018-06-12T00:47:14Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+          "ResourceProvider",
+          "Operations"
+        ],
+        "operationId": "OperationGet_list",


The operation ID here should just be "Operations_List"

annatisch · 2018-06-12T00:52:44Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+                "type": "string"
+              }
+            }
+


You can use the x-ms-client-name extension to rename this for a better developer experience:

"x-ms-client-name": "pauseWaitForSyncDrainTimePeriodInSeconds"

"pauseWaitForSyncDrainTimePeriodInSeconds": {
"type": "integer",
"description": "Pre Restore pause wait for sync drain time period in seconds."
"x-ms-client-name": "pauseWaitForSyncDrainTimePeriodInSeconds"
}

annatisch · 2018-06-12T01:00:00Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+                "type": "string"
+              }
+            }
+


Operation ID should be in the format group_verb. So this should be changed to:
"operationId": "Workflows_abort"

Resolved. Workflows_Abort

annatisch · 2018-06-12T01:15:07Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+        "tags": [
+          "StorageSyncServices Resource"
+        ],
+        "operationId": "StorageSyncServiceByResourceGroupGet_list",


Operation ID should be in the format "group_verb". So this should be changed to something like:
"operationId": "StorageSyncServices_ListByResourceGroup"

annatisch · 2018-06-12T01:15:33Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+        "tags": [
+          "StorageSyncServices Resource"
+        ],
+        "operationId": "StorageSyncServiceGet_ListBySubscription",


Operation ID should be in the format "group_verb". So this should be changed to something like:
"operationId": "StorageSyncServices_ListBySubscription"

annatisch · 2018-06-12T01:16:05Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+        "tags": [
+          "SyncGroup Resource"
+        ],
+        "operationId": "GetSyncGroups_ListByStorageSyncService",


Operation ID should be in the format "group_verb". So this should be changed to something like:
"operationId": "SyncGroups_ListByStorageSyncService"

annatisch · 2018-06-12T01:16:40Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+        "tags": [
+          "CloudEndpoint Resource"
+        ],
+        "operationId": "CloudEndpointsGet_ListBySyncGroup",


Operation ID should be in the format "group_verb". So this should be changed to something like:
"operationId": "CloudEndpoints_ListBySyncGroup"

annatisch · 2018-06-12T01:17:00Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+          "Actions",
+          "Backup Restore"
+        ],
+        "operationId": "CloudEndpointPreBackup_Post",


Operation ID should be in the format "group_verb". So this should be changed to something like:
"operationId": "CloudEndpoints_PreBackup"

Review comments

…sh2/azure-rest-api-specs into storagesync-preview

StorageSyncError change

annatisch · 2018-06-12T02:55:36Z

@ankushbindlish2 - thanks for all the updates! With regards to pausewaitforsyncdraintimeperiodinseconds, the name of the property needs to be the same capitalization as the request over the wire. So something like this:

"pausewaitforsyncdraintimeperiodinseconds": {
  "type": "integer",
  "description": "Pre Restore pause wait for sync drain time period in seconds.",
  "x-ms-client-name": "pauseWaitForSyncDrainTimePeriodInSeconds"
}

What this does is it will convert the name to the best language-specific capitalization for the generated SDKs. e.g. for Python, the property will be pause_wait_for_sync_drain_time_period_in_seconds. But the SDK will automatically convert it into the correct pausewaitforsyncdraintimeperiodinseconds when building the request to send over the wire.

extra comma in pauseWaitForSyncDrainTimePeriodInSeconds

body to parameters

annatisch · 2018-06-12T20:41:21Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T20:46:58Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T20:48:19Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T20:49:31Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T20:50:07Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T20:50:40Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T22:02:56Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T22:03:06Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T22:03:13Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            "type": "string"
+          },
+          {
+            "name": "body",


Could this be renamed to something like "parameters"

annatisch · 2018-06-12T22:05:14Z

...ation/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json

+            },
+            "headers": {
+              "x-ms-request-id": {
+


Could this be renamed to something like "parameters"

Storage Sync Swagger preview version (prev PR #109

dbb835b

salameer assigned annatisch Jun 11, 2018

ankushbindlish2 mentioned this pull request Jun 11, 2018

Merging change from AddStorageSync branch to master. #3196

Closed

10 tasks

Added Python code gen config

ac02d82

Added NodeJS + Java code gen config

bdcb59f

annatisch requested changes Jun 12, 2018

View reviewed changes

ankushbindlish2 added 3 commits June 11, 2018 19:04

Review comments

092314e

Review comments

Merge branch 'storagesync-preview' of https://github.com/ankushbindli…

6588708

…sh2/azure-rest-api-specs into storagesync-preview

StorageSyncError change

5dc55a8

StorageSyncError change

ankushbindlish2 and others added 12 commits June 12, 2018 12:39

extra comma

3c0da5b

extra comma in pauseWaitForSyncDrainTimePeriodInSeconds

body to parameters

dd8124f

body to parameters

Update RegisteredServers_Create example

f112ace

Updated ServerEndpoints_Create example

3959a7c

Updated CloudEndpoints_PostRestore example

8a6714e

Updated CloudEndpoints_PreRestore example

31b381d

Updated CloudEndpoints_PostBackup example

e34cf44

Updated StorageSyncServices_Create example

20cef78

Updated SyncGroups_Create example

c4634e6

Updated CloudEndpoints_Create example

b4e93c4

Updated CloudEndpoints_PreBackup example

8eff709

Updated ServerEndpoints_Update example

3482fe1

Updated StorageSyncServices_Update example

689d378

annatisch approved these changes Jun 13, 2018

View reviewed changes

annatisch merged commit ffb011f into Azure:master Jun 13, 2018

ankushbindlish2 mentioned this pull request Jun 13, 2018

Add new version 2018-04-02 for Microsoft.StorageSync Resource Provider #3229

Closed

10 tasks

annatisch mentioned this pull request Jun 14, 2018

Add new version 2018-04-02 for Microsoft.StorageSync Resource Provider #3238

Merged

10 tasks

Conversation

ankushbindlish2 commented Jun 11, 2018

PR information

Quality of Swagger

Uh oh!

AutorestCI commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-libraries-for-java

Uh oh!

AutorestCI commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-ruby

Uh oh!

AutorestCI commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

AutorestCI commented Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

annatisch commented Jun 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

AutorestCI commented Jun 11, 2018 •

edited

Loading

AutorestCI commented Jun 11, 2018 •

edited

Loading

AutorestCI commented Jun 11, 2018 •

edited

Loading

AutorestCI commented Jun 11, 2018 •

edited

Loading

AutorestCI commented Jun 11, 2018 •

edited

Loading